CuDoubleSidedScannerC  1.22
dss_Error.h File Reference

Error list and description. More...

Go to the source code of this file.

Enumerations

enum  DssResult : DWORD {
  DssResult_OK = 0,
  DssResult_ScannerOffline =1,
  DssResult_OpenDeviceError =2,
  DssResult_InvalidParameter = 3,
  DssResult_SmallBuffer = 4,
  DssResult_NullPointer = 5,
  DssResult_NotInitialized = 6,
  DssResult_InvalidDeviceID = 7,
  DssResult_DeviceNotOpened = 8,
  DssResult_NoDeviceAnswer = 9,
  DssResult_WriteError = 10,
  DssResult_JobNotValid = 11,
  DssResult_ScanJobOpenError = 12,
  DssResult_InvalidCommand = 13,
  DssResult_DeviceAnswerUnknown = 14,
  DssResult_NoDocumentScanned = 15,
  DssResult_SyncronizationErr = 16,
  DssResult_NoDocumentToBeScanned = 18,
  DssResult_PaperJam = 19,
  DssResult_PaperHeldBack = 20,
  DSSResult_ScannerJam = 21,
  DssResult_ScannerError = 22,
  DssResult_CommunicationUnknownError = 23,
  DssResult_RequestNotSupported = 24,
  DssResult_LibraryAlreadyInitialized = 25,
  DssResult_ScannerBusy = 26,
  DssResult_ErrCoverOpen = 27,
  DssResult_ScanInconsistentData = 28,
  DssResult_ScanImpeded = 29,
  DssResult_MICRNotFound = 30,
  DssResult_MICRDetectInProgress = 31,
  DssResult_UpgFileOpenError = 32,
  DssResult_UpgBootImageTagMissed = 33,
  DssResult_UpgAcceptLenNotMatch = 34,
  DssResult_UpgImageWriteError = 35,
  DssResult_UpgChecksumError = 36,
  DssResult_UpgWrongFileFormatError = 37,
  DssResult_VoidTicketNotPresent = 38,
  DssResult_VoidPrintHeadError = 39,
  DssResult_RequestedDataNoLongerAvailable = 40,
  DssResult_DoubleSheet = 41
}
 

Functions

static const wchar_t * DssResultToText (DssResult result)
 

Detailed Description

Error list and description.

Enumeration Type Documentation

◆ DssResult

enum DssResult : DWORD

Error list

Enumerator
DssResult_OK 

All OK.

DssResult_ScannerOffline 

Scanner offline.

DssResult_OpenDeviceError 

Open device error. Device probably offline.

DssResult_InvalidParameter 

Invalid parameter.

DssResult_SmallBuffer 

Small buffer.

DssResult_NullPointer 

Null or invalid pointer.

DssResult_NotInitialized 

Library not initialized.

DssResult_InvalidDeviceID 

Invalid device ID.

DssResult_DeviceNotOpened 

Device is closed.Did you forget ConnectScanner?

DssResult_NoDeviceAnswer 

The device doesn't answer.

DssResult_WriteError 

Write error.

DssResult_JobNotValid 

Scan job not valid. Maybe a ConnectScanner is needed.

DssResult_ScanJobOpenError 

Scan job open error.

DssResult_InvalidCommand 

Invalid command.

DssResult_DeviceAnswerUnknown 

Device answer unknown.

DssResult_NoDocumentScanned 

No document has been scanned for this side.

DssResult_SyncronizationErr 

Communication syncronization error.

DssResult_NoDocumentToBeScanned 

No document has been inserted to be scanned.

DssResult_PaperJam 

Paper jam.

DssResult_PaperHeldBack 

The paper has been held back by the user.

DSSResult_ScannerJam 

It is not possible to perform or complete the current operation. Scanner jam state.

DssResult_ScannerError 

Scanner answer is an error code, or the scanner is in an error state.

DssResult_CommunicationUnknownError 

Communication unknown error.

DssResult_RequestNotSupported 

The request is not supported by the current device. Request not available.

DssResult_LibraryAlreadyInitialized 

The library has already been initialized. Please deinitilize library before re-initialize it.

DssResult_ScannerBusy 

The scanner is busy. Probably a scan job is in progress.

DssResult_ErrCoverOpen 

Impossible to perform the requested operation. The scanner cover is open.

DssResult_ScanInconsistentData 

Data returned by the last/current scan job are inconsistent.

DssResult_ScanImpeded 

A trouble impeded to perform a correct scan. (Scan timeout or power supply error)

DssResult_MICRNotFound 

Magnetic ink character recognition failed. Data not found or not detected.

DssResult_MICRDetectInProgress 

Magnetic ink character recognition in progress.

DssResult_UpgFileOpenError 

Upgrade error: upgrade file not found.

DssResult_UpgBootImageTagMissed 

Upgrade error: boot image tag missed.

DssResult_UpgAcceptLenNotMatch 

Upgrade error: upgrade file accept length not match.

DssResult_UpgImageWriteError 

Upgrade error: error in writing upgrade data on scanner.

DssResult_UpgChecksumError 

Upgrade error: checksum error.

DssResult_UpgWrongFileFormatError 

Upgrade error: file inconsistent. Wrong file format.

DssResult_VoidTicketNotPresent 

Void ticket: paper not present on print head. Cannot continue.

DssResult_VoidPrintHeadError 

Void ticket: print head is down. This situation will cause troubles during the next scan job.

DssResult_RequestedDataNoLongerAvailable 

The data requested are no longer available.

DssResult_DoubleSheet 

It is not possible to perform or complete the current operation. Scanner found double sheet.

Function Documentation

◆ DssResultToText()

static const wchar_t* DssResultToText ( DssResult  result)
static

Translates DssResult to the related text message.

Parameters
resultResult value to be translated to text.
Returns
A null-terminated string containing the description.

Referenced by ClearImagesData(), ConnectScanner(), GetBWThreshold(), GetCropParameters(), GetScanCounter(), GetScannerStatus(), GetVoidPrintedPaperLen(), SetBWThreshold(), SetCropParameters(), SetLedBar(), SetRejectMargins(), StartScan(), and VoidTicket().